home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / dsyevx.z / dsyevx
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4. DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))                                                          DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      DSYEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      real symmetric matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE DSYEVX( JOBZ, RANGE, UPLO, N, A, LDA, VL, VU, IL, IU, ABSTOL,
  14.                         M, W, Z, LDZ, WORK, LWORK, IWORK, IFAIL, INFO )
  15.  
  16.          CHARACTER      JOBZ, RANGE, UPLO
  17.  
  18.          INTEGER        IL, INFO, IU, LDA, LDZ, LWORK, M, N
  19.  
  20.          DOUBLE         PRECISION ABSTOL, VL, VU
  21.  
  22.          INTEGER        IFAIL( * ), IWORK( * )
  23.  
  24.          DOUBLE         PRECISION A( LDA, * ), W( * ), WORK( * ), Z( LDZ, * )
  25.  
  26. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  27.      These routines are part of the SCSL Scientific Library and can be loaded
  28.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  29.      directs the linker to use the multi-processor version of the library.
  30.  
  31.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  32.      4 bytes (32 bits). Another version of SCSL is available in which integers
  33.      are 8 bytes (64 bits).  This version allows the user access to larger
  34.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  35.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  36.      only one of the two versions; 4-byte integer and 8-byte integer library
  37.      calls cannot be mixed.
  38.  
  39. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  40.      DSYEVX computes selected eigenvalues and, optionally, eigenvectors of a
  41.      real symmetric matrix A. Eigenvalues and eigenvectors can be selected by
  42.      specifying either a range of values or a range of indices for the desired
  43.      eigenvalues.
  44.  
  45.  
  46. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  47.      JOBZ    (input) CHARACTER*1
  48.              = 'N':  Compute eigenvalues only;
  49.              = 'V':  Compute eigenvalues and eigenvectors.
  50.  
  51.      RANGE   (input) CHARACTER*1
  52.              = 'A': all eigenvalues will be found.
  53.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  54.              found.  = 'I': the IL-th through IU-th eigenvalues will be found.
  55.  
  56.      UPLO    (input) CHARACTER*1
  57.              = 'U':  Upper triangle of A is stored;
  58.              = 'L':  Lower triangle of A is stored.
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))                                                          DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      N       (input) INTEGER
  75.              The order of the matrix A.  N >= 0.
  76.  
  77.      A       (input/output) DOUBLE PRECISION array, dimension (LDA, N)
  78.              On entry, the symmetric matrix A.  If UPLO = 'U', the leading N-
  79.              by-N upper triangular part of A contains the upper triangular
  80.              part of the matrix A.  If UPLO = 'L', the leading N-by-N lower
  81.              triangular part of A contains the lower triangular part of the
  82.              matrix A.  On exit, the lower triangle (if UPLO='L') or the upper
  83.              triangle (if UPLO='U') of A, including the diagonal, is
  84.              destroyed.
  85.  
  86.      LDA     (input) INTEGER
  87.              The leading dimension of the array A.  LDA >= max(1,N).
  88.  
  89.      VL      (input) DOUBLE PRECISION
  90.              VU      (input) DOUBLE PRECISION If RANGE='V', the lower and
  91.              upper bounds of the interval to be searched for eigenvalues. VL <
  92.              VU.  Not referenced if RANGE = 'A' or 'I'.
  93.  
  94.      IL      (input) INTEGER
  95.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  96.              order) of the smallest and largest eigenvalues to be returned.  1
  97.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  98.              referenced if RANGE = 'A' or 'V'.
  99.  
  100.      ABSTOL  (input) DOUBLE PRECISION
  101.              The absolute error tolerance for the eigenvalues.  An approximate
  102.              eigenvalue is accepted as converged when it is determined to lie
  103.              in an interval [a,b] of width less than or equal to
  104.  
  105.              ABSTOL + EPS *   max( |a|,|b| ) ,
  106.  
  107.              where EPS is the machine precision.  If ABSTOL is less than or
  108.              equal to zero, then  EPS*|T|  will be used in its place, where
  109.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  110.              A to tridiagonal form.
  111.  
  112.              Eigenvalues will be computed most accurately when ABSTOL is set
  113.              to twice the underflow threshold 2*DLAMCH('S'), not zero.  If
  114.              this routine returns with INFO>0, indicating that some
  115.              eigenvectors did not converge, try setting ABSTOL to
  116.              2*DLAMCH('S').
  117.  
  118.              See "Computing Small Singular Values of Bidiagonal Matrices with
  119.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  120.              Working Note #3.
  121.  
  122.      M       (output) INTEGER
  123.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  124.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))                                                          DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      W       (output) DOUBLE PRECISION array, dimension (N)
  141.              On normal exit, the first M elements contain the selected
  142.              eigenvalues in ascending order.
  143.  
  144.      Z       (output) DOUBLE PRECISION array, dimension (LDZ, max(1,M))
  145.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  146.              the orthonormal eigenvectors of the matrix A corresponding to the
  147.              selected eigenvalues, with the i-th column of Z holding the
  148.              eigenvector associated with W(i).  If an eigenvector fails to
  149.              converge, then that column of Z contains the latest approximation
  150.              to the eigenvector, and the index of the eigenvector is returned
  151.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  152.              user must ensure that at least max(1,M) columns are supplied in
  153.              the array Z; if RANGE = 'V', the exact value of M is not known in
  154.              advance and an upper bound must be used.
  155.  
  156.      LDZ     (input) INTEGER
  157.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  158.              'V', LDZ >= max(1,N).
  159.  
  160.      WORK    (workspace/output) DOUBLE PRECISION array, dimension (LWORK)
  161.              On exit, if INFO = 0, WORK(1) returns the optimal LWORK.
  162.  
  163.      LWORK   (input) INTEGER
  164.              The length of the array WORK.  LWORK >= max(1,8*N).  For optimal
  165.              efficiency, LWORK >= (NB+3)*N, where NB is the max of the
  166.              blocksize for DSYTRD and DORMTR returned by ILAENV.
  167.  
  168.              If LWORK = -1, then a workspace query is assumed; the routine
  169.              only calculates the optimal size of the WORK array, returns this
  170.              value as the first entry of the WORK array, and no error message
  171.              related to LWORK is issued by XERBLA.
  172.  
  173.      IWORK   (workspace) INTEGER array, dimension (5*N)
  174.  
  175.      IFAIL   (output) INTEGER array, dimension (N)
  176.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  177.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  178.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  179.              is not referenced.
  180.  
  181.      INFO    (output) INTEGER
  182.              = 0:  successful exit
  183.              < 0:  if INFO = -i, the i-th argument had an illegal value
  184.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  185.              indices are stored in array IFAIL.
  186.  
  187. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  188.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))                                                          DDDDSSSSYYYYEEEEVVVVXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      This man page is available only online.
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.